/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University. All rights reserved.
 * 
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license; 2) All redistributions in binary form
 * must reproduce the above copyright notice, this list of conditions and the
 * disclaimer listed in this license in the documentation and/or other materials
 * provided with the distribution; 3) Any documentation included with all
 * redistributions must include the following acknowledgement:
 * 
 * "This product includes software developed by the Community Grids Lab. For
 * further information contact the Community Grids Lab at
 * http://communitygrids.iu.edu/."
 * 
 * Alternatively, this acknowledgement may appear in the software itself, and
 * wherever such third-party acknowledgments normally appear.
 * 
 * 4) The name Indiana University or Community Grids Lab or NaradaBrokering,
 * shall not be used to endorse or promote products derived from this software
 * without prior written permission from Indiana University. For written
 * permission, please contact the Advanced Research and Technology Institute
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202. 5) Products
 * derived from this software may not be called NaradaBrokering, nor may Indiana
 * University or Community Grids Lab or NaradaBrokering appear in their name,
 * without prior written permission of ARTI.
 * 
 * 
 * Indiana University provides no reassurances that the source code provided
 * does not infringe the patent or any other intellectual property rights of any
 * other entity. Indiana University disclaims any liability to any recipient for
 * claims brought by any other entity based on infringement of intellectual
 * property rights or otherwise.
 * 
 * LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO
 * WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 * NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF
 * INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS.
 * INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS",
 * "VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.
 * LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR
 * ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION
 * GENERATED USING SOFTWARE.
 */
package cgl.narada.service.qos;

import cgl.narada.event.EventID;
import cgl.narada.event.NBEvent;

/**
 * The QosEvent which plays an important role in
 * 
 * @author Shrideep Pallickara $Date$ $Revision$
 */

public interface QosEvent {

   /** Returns the event id associated with the encapsulated event */
   public EventID getEventId();

   /** Returns the encapsulated event */
   public NBEvent getNBEvent();

   /** Indicates if there are any producer constraints that were specified */
   public boolean hasProducerConstraints();

   /** Return the producer constraints */
   public ProducerConstraints getProducerConstraints();

   /** Get the pending consumer constraints */
   public ConsumerConstraints[] getPendingConsumerConstraints();

   /** Indicates if there are any consumer constraints that were specified */
   public boolean hasConsumerConstraints();

   /** Returns the number of pending consumer constraints */
   public int getNumberofConsumerConstraints();

   /**
    * Indicates if the event had multiple consumer constraints that were
    * specified
    */
   public boolean hasMultipleConsumerConstraints();

   /**
    * Add consumer constraints associated with this event. This method can be
    * called repeatedly to add more than 1 registered consumer constraints from
    * matching consumers.
    */
   public void addConsumerConstraints(ConsumerConstraints _consumerConstraints);

   /**
    * If there are any consumer constraints that have been satisfied, based on
    * the QosIdentifiers associated with this event -- that constraint will be
    * returned. <br>
    * The method will return a NULL under the following conditions (a) If no
    * consumer constraints have been satisfied OR (b) If all constraints have
    * been satisfied OR (c) If no consumer constraints were specified
    */
   public ConsumerConstraints getSatisfiedConsumerConstraints();

   /** Indicates the current processing state of this event */
   public QosIdentifiers getQosIdentifiers();

   /**
    * This method returns the service which the event must be routed to for
    * further processing. If this returns 0, no further processing is required.
    * A 0 indicates that no service was found for special processing, and that
    * the event is ready to be released (either to the application or to the
    * communications stream )
    */
   public int getServiceToBeRoutedTo();

}
